home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / isamax.z / isamax
Encoding:
Text File  |  2002-10-03  |  13.4 KB  |  331 lines

  1.  
  2.  
  3.  
  4. IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))                                                          IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      IIIISSSSAAAAMMMMAAAAXXXX, IIIIDDDDAAAAMMMMAAAAXXXX, IIIICCCCAAAAMMMMAAAAXXXX, IIIIZZZZAAAAMMMMAAAAXXXX - Searches a vector for the first
  10.      occurrence of the maximum absolute value
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision
  14.  
  15.           Fortran:
  16.                iiiinnnntttteeeeggggeeeerrrr IIIISSSSAAAAMMMMAAAAXXXX
  17.                iiiinnnntttteeeeggggeeeerrrr _i_n_d_e_x
  18.                _i_n_d_e_x = IIIISSSSAAAAMMMMAAAAXXXX ((((_n,,,, _x,,,, _i_n_c_x))))
  19.  
  20.           C/C++:
  21.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  22.                iiiinnnntttt iiiissssaaaammmmaaaaxxxx ((((iiiinnnntttt _n,,,, ffffllllooooaaaatttt *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  23.  
  24.      Double precision
  25.  
  26.           Fortran:
  27.                iiiinnnntttteeeeggggeeeerrrr IIIIDDDDAAAAMMMMAAAAXXXX
  28.                iiiinnnntttteeeeggggeeeerrrr _i_n_d_e_x
  29.                _i_n_d_e_x = IIIIDDDDAAAAMMMMAAAAXXXX ((((_n,,,, _x,,,, _i_n_c_x))))
  30.  
  31.           C/C++:
  32.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  33.                iiiinnnntttt iiiiddddaaaammmmaaaaxxxx ((((iiiinnnntttt _n,,,, ddddoooouuuubbbblllleeee *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  34.  
  35.      Single precision complex
  36.  
  37.           Fortran:
  38.                iiiinnnntttteeeeggggeeeerrrr IIIICCCCAAAAMMMMAAAAXXXX
  39.                iiiinnnntttteeeeggggeeeerrrr _i_n_d_e_x
  40.                _i_n_d_e_x = IIIICCCCAAAAMMMMAAAAXXXX ((((_n,,,, _x,,,, _i_n_c_x))))
  41.  
  42.           C/C++:
  43.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  44.                iiiinnnntttt iiiiccccaaaammmmaaaaxxxx ((((iiiinnnntttt _n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  45.  
  46.           C++ STL:
  47.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  48.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  49.                iiiinnnntttt iiiiccccaaaammmmaaaaxxxx ((((iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  50.  
  51.      Double precision complex
  52.  
  53.           Fortran:
  54.                iiiinnnntttteeeeggggeeeerrrr IIIIZZZZAAAAMMMMAAAAXXXX
  55.                iiiinnnntttteeeeggggeeeerrrr _i_n_d_e_x
  56.  
  57.                _i_n_d_e_x = IIIIZZZZAAAAMMMMAAAAXXXX ((((_n,,,, _x,,,, _i_n_c_x))))
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))                                                          IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))
  71.  
  72.  
  73.  
  74.           C/C++:
  75.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  76.                iiiinnnntttt iiiizzzzaaaammmmaaaaxxxx ((((iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  77.  
  78.           C++ STL:
  79.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  80.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  81.                iiiinnnntttt iiiizzzzaaaammmmaaaaxxxx ((((iiiinnnntttt _n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_x,,,, iiiinnnntttt _i_n_c_x))));;;;
  82.  
  83. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  84.      These routines are part of the SCSL Scientific Library and can be loaded
  85.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  86.      directs the linker to use the multi-processor version of the library.
  87.  
  88.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  89.      4 bytes (32 bits). Another version of SCSL is available in which integers
  90.      are 8 bytes (64 bits).  This version allows the user access to larger
  91.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  92.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  93.      only one of the two versions; 4-byte integer and 8-byte integer library
  94.      calls cannot be mixed.
  95.  
  96.      The C and C++ prototypes shown above are appropriate for the 4-byte
  97.      integer version of SCSL. When using the 8-byte integer version, the
  98.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  99.      file should be included.
  100.  
  101. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  102.      IIIISSSSAAAAMMMMAAAAXXXX/IIIIDDDDAAAAMMMMAAAAXXXX searches a real vector for the first occurrence of the
  103.      maximum absolute value.
  104.  
  105.      IIIICCCCAAAAMMMMAAAAXXXX/IIIIZZZZAAAAMMMMAAAAXXXX searches a complex vector for the first occurrence of the
  106.      maximum absolute value.
  107.  
  108.      IIIISSSSAAAAMMMMAAAAXXXX returns the first index _i such that
  109.  
  110.           |x | = MAX |x | : j = 1, ..., n
  111.             i          j   (j = 0, ..., n-1 for C/C++)
  112.  
  113.  
  114.  
  115.      where _x_j is an element of a real vector.
  116.  
  117.  
  118.      IIIICCCCAAAAMMMMAAAAXXXX determines the first index _i such that
  119.  
  120.           |Real(x )| + |Imag(x )| =
  121.                  i            i
  122.  
  123.           MAX(|Real(x )| + |Imag(x )|) : j = 1, ..., n
  124.                      j            j     (j = 0, ..., n-1 for C/C++)
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))                                                          IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      where _x_j is an element of a complex vector.
  141.  
  142.  
  143.      See the NOTES section of this man page for information about the
  144.      interpretation of the data types described in the following arguments.
  145.  
  146.      These functions have the following arguments:
  147.  
  148.      _i_n_d_e_x Integer.  (output)
  149.            First index of maximum absolute value.
  150.  
  151.      _n     Integer.  (input)
  152.            Number of elements to process in the vector to be searched.  If _n
  153.            <= 0, these routines return 0 (-1 for C/C++).
  154.  
  155.      _x     Array of dimension (_n-1) * |_i_n_c_x| + 1.  (input)
  156.            IIIISSSSAAAAMMMMAAAAXXXX: Single precision array.
  157.            IIIIDDDDAAAAMMMMAAAAXXXX: Double precision array.
  158.            IIIICCCCAAAAMMMMAAAAXXXX: Single precision complex array.
  159.            IIIIZZZZAAAAMMMMAAAAXXXX: Double precision complex array.
  160.  
  161.            Array _x contains the vector to be searched.
  162.  
  163.      _i_n_c_x  Integer.  (input)
  164.            Increment between elements of _x.
  165.  
  166. NNNNOOOOTTTTEEEESSSS
  167.      When scanning backward (_i_n_c_x < 0), each routine starts at the end of the
  168.      vector and moves backward, as follows:
  169.  
  170.      Fortran:
  171.  
  172.           x(1 - incx * (n-1)), x(1 - incx * (n-2)), ..., x(1)
  173.  
  174.  
  175.      C/C++:
  176.  
  177.           x[-incx * (n-1)], x[incx * (n - 2)], ..., x(0)
  178.  
  179.  
  180.      The largest absolute value is:
  181.  
  182.      Fortran:
  183.  
  184.           |x(1 + incx * (index-1))| when incx > 0
  185.  
  186.           |x(1 - incx * (n-index))| when incx < 0
  187.  
  188.  
  189.      C/C++:
  190.  
  191.           |x[incx * (index-1)]| when incx > 0
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))                                                          IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))
  203.  
  204.  
  205.  
  206.           |x[-incx * (n-index)]| when incx < 0
  207.  
  208.  
  209.      These routines are Level 1 Basic Linear Algebra Subprograms (Level 1
  210.      BLAS).
  211.  
  212.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  213.      The following data types are described in this documentation:
  214.  
  215.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  216.  
  217.      Fortran:
  218.  
  219.           Array dimensioned _n           xxxx((((nnnn))))
  220.  
  221.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  222.  
  223.           Single precision              RRRREEEEAAAALLLL
  224.  
  225.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  226.  
  227.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  228.  
  229.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  230.  
  231.      C/C++:
  232.  
  233.           Array dimensioned _n           xxxx[[[[_n]]]]
  234.  
  235.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  236.  
  237.           Single precision              ffffllllooooaaaatttt
  238.  
  239.           Double precision              ddddoooouuuubbbblllleeee
  240.  
  241.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  242.  
  243.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  244.  
  245.      C++ STL:
  246.  
  247.           Array dimensioned _n           xxxx[[[[_n]]]]
  248.  
  249.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  250.  
  251.           Single precision              ffffllllooooaaaatttt
  252.  
  253.           Double precision              ddddoooouuuubbbblllleeee
  254.  
  255.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))                                                          IIIISSSSAAAAMMMMAAAAXXXX((((3333SSSS))))
  269.  
  270.  
  271.  
  272.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  273.  
  274. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  275.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS1111(3S), IIIISSSSMMMMAAAAXXXX(3S)
  276.  
  277.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  278.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  279.      Linear Algebra Subprograms Technical Forum.
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.